home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / yt34b10.zip / YTSYSOP.DOC < prev   
Text File  |  1992-08-23  |  19KB  |  420 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                   Y     Y AAAAA   N    N K  K EEEEE EEEEE
  7.                    Y   Y  A   A   NN   N K K  E     E
  8.                     Y Y   AAAAA   N N  N KK   EEE   EEE
  9.                      Y    A   A   N  N N KK   E     E
  10.                      Y    A   A   N   NN K K  E     E
  11.                      Y    A   A   N    N K  K EEEEE EEEEE
  12.  
  13.                     TTTTTTT RRRR AAAAA DDDD  EEEEE RRRR !!
  14.                        T    R  R A   A D   D E     R  R !!
  15.                        T    RRRR AAAAA D   D EEE   RRRR !!
  16.                        T    RR   A   A D   D E     RR   !!
  17.                        T    R R  A   A D   D E     R R
  18.                        T    R  R A   A DDDD  EEEEE R  R !!
  19.  
  20.  
  21.                               by Alan Davenport
  22.  
  23.  
  24.  
  25.  
  26.         "It is a period of great instability. Mankind has broken the time and
  27. distance barrier to the stars with inexpensive warp driven space ships. Anyone
  28. with enough credits can buy a ship and head out into the void. Chaos rules.
  29. The central Earth government found that it is impossible to maintain law and
  30. order throughout the vastness of space and on the countless outposts that have
  31. appeared almost overnight. The only law is of survival. The only hope for
  32. survival is in strength. The only way to strength is through ruthless trading
  33. of basic goods. It seems that all ports always have too much or too little of
  34. one thing or another. You've purchased your ship, barely able to afford the
  35. minimum of holds, defensive fighters, a few remote sensor robots, and a few
  36. days cloaking charge. An ant to be squashed by the more powerful trader
  37. barons. However, you are smart. You are confident that you can hide out long
  38. enough to equip your ship with more powerful arms and holds and that you will
  39. one day be a trader baron to be feared!"
  40.  
  41.  
  42.         Yankee Trader is the result of thousands of hours of work. The total
  43. source code is well over 15 THOUSAND lines. While being developed, it was
  44. completely rewritten from top to bottom many times over. Afterward, many
  45. months of fine tuning, to achieve a decent game balance, followed.
  46.  
  47.  
  48.         Yankee Trader is a space trading/war game. There are several different
  49. door games of this genre. The original idea for such a game was called "Trade
  50. Wars (c)" which was first published by Hewlett Packard in "The People's Book
  51. of Computer Games 1 and 2" and was first converted to a BBS door by Chris
  52. Sherrick. The door game became very popular and many different versions still
  53. exist today. Several other space trading/war games have appeared in recent
  54. years also.
  55.  
  56.  
  57.         Yankee Trader takes the idea of a space trading/war game to new
  58. heights. There are many new ideas and enhancements to the old theme. The idea
  59. of a space trading/war game still remains, the result however is something
  60. entirely different, YANKEE TRADER!
  61.  
  62.  
  63.         This door is the result of my love for programming. I have fixed every
  64. bug that I have found and I believe that it is reasonably clean however it is
  65. NOT a commercial product but the result of programming for a hobby. As such
  66. there is NO GUARANTEE OF ANY KIND EXPRESSED OR IMPLIED. IN NO CASE SHALL I BE
  67. HELD RESPONSIBLE FOR ANY DAMAGES OR LOSSES RESULTING FROM YOU RUNNING THIS
  68. SOFTWARE, EVEN IF I HAVE BEEN INFORMED OF POSSIBLE OR REAL PROBLEMS. BY
  69. RUNNING THIS SOFTWARE YOU HAVE AGREED TO TAKE RESPONSIBILITY FOR ANY PROBLEMS
  70. THAT MAY RESULT. IF YOU DO NOT AGREE TO THIS, DO NOT RUN ANY OF THE PROGRAMS
  71. IN THIS PACKAGE. NOT EVEN ONCE!
  72.  
  73.  
  74. General information :-
  75.  
  76. This door uses the Microsoft QuickBasic 3.0 run time module BRUN30.EXE. The
  77. reason for using the run time module instead of making stand alone programs is
  78. to keep the distribution package a reasonable size.. otherwise it would be
  79. almost 600K! This copy of the run time module has been patched so that it does
  80. NOT cause the modem to hang up on the caller when they exit the door and it
  81. ALSO has been patched so that it will EXIT if ever the message "Fatal Error,
  82. Hit any key to return to the system" appears providing you with an extra level
  83. of protection against hanging your system in the event of a severe error/bug!
  84.  
  85.         BRUN30 doesn't HAVE to be in the directory with the game files, just
  86. as long as it is in your system PATH someplace. Since this copy has the extra
  87. patches applied to it and if you have other doors that use BRUN30, you may
  88. want to put it in your path (Utilities directory?) and delete all other copies
  89. of BRUN30 you may have. This will save you some disk space and also give you
  90. extra protection while running other BRUN30 dependent doors. However if you do
  91. not use BRUN30 any other place, you should place it in your YT directory. This
  92. will make the game load marginally faster since your system doesn't have to
  93. search the entire path to find BRUN30.
  94.  
  95.  
  96. Getting set up :-
  97.  
  98.         Starting with the basics, decide which drive you wish to run the door
  99. on and make a directory to hold all the files. Move ALL of the files in this
  100. package into that directory. You are now ready to run the initialization
  101. program.
  102.  
  103.  
  104. Initializing the game :-
  105.  
  106.         Before you can run the game, you must run the initialization program
  107. "YT-INIT.EXE". This program will set up ALL the data files needed to run the
  108. game. You can also run YT-INIT any time you wish to restart an old game. The
  109. game is open ended and you will never HAVE to run YT-INIT but sometimes, when
  110. a game starts to get old, you may wish to restart everyone over fresh.
  111.  
  112.         There is one piece of information you will need to give to the
  113. initialization program. That is the full path and NAME of the scoreboard
  114. bulletin. This is a straight ASCII text file that you can display from your
  115. BBS. The maximum length of your scoreboard path/name description is 41
  116. characters. An example of an entry for a scoreboard file is;
  117.  
  118. C:\BBS\TXTFILES\YTSCORE.ASC
  119.  
  120.         You may change the scoreboard description any time you wish by using
  121. the game's configuration program. (If you get an error when the game tries to
  122. generate the scoreboard you messed up the path/name somehow!)
  123.  
  124.         Once you are done running YT-INIT, you should bring up the game's
  125. configuration program by typing "YTCONFIG.EXE". The default settings provided
  126. by the initialization program will provide a decent game however, once you
  127. become more familiar with the game, you may wish to change some of them
  128. around.
  129.  
  130.  
  131. The "RMT-INIT.EXE" Program :-
  132.  
  133.         This program is used by YT.EXE itself to run the user "Initiate
  134. Genesis" function. When called by the game it will run with no intervention.
  135. It takes your old, previously defined defaults and re-initializes the game.
  136. You will find this program useful to re-start the game yourself. When run from
  137. the DOS prompt, it will ask you if you REALLY want to re-start the game using
  138. your old defaults. RMT-INIT.EXE will NOT do an initial initialization. To use
  139. this program, you must have initialized the game using YT-INIT.EXE previously.
  140.  
  141.  
  142. Running Maintenance :-
  143.  
  144.         The first thing you should do after RMT-INIT completes successfully is
  145. type YTMAINT and press enter in the game's directory. THIS IS IMPORTANT TO
  146. INITIALIZE SOME OF THE AUTOMATIC FUNCTIONS! (YT-INIT automatically runs
  147. YTMAINT.) You should add an entry in your system maintenance batch file to run
  148. YTMAINT.EXE EVERY day ONCE per DAY. YTMAINT is in integral part of Yankee
  149. Trader and if you do NOT run it on daily basis you will SEVERELY inhibit the
  150. game! (Perhaps RUIN the game is a better description!) An example of the batch
  151. file entries needed to be added to your SYSMAINT.BAT file are below;
  152.  
  153. c:
  154. cd \bbs\doors\yt
  155. ytmaint.exe
  156. cd \bbs
  157.  
  158.  
  159. Running Yankee Trader from a BBS :-
  160.  
  161.         SHARE MUST BE LOADED IN ORDER TO RUN YANKEE TRADER!
  162.  
  163.         Yankee Trader uses the file created by QuickBBS, Remote Access and
  164. other BBS programs use to pass information to the door programs from the BBS
  165. called DORINFO1.DEF. To run YT, you must pass the path and NAME of the
  166. DORINFO1.DEF file to YT on the command line. There are converters to make
  167. DORINFO1.DEF for just about all other BBS programs out there.
  168.  
  169.         To run Yankee Trader from your BBS, you must tell it where to find
  170. DORINFOx.DEF from your BBS. (Replace the "x" in the example with the BBS node
  171. number if running multi-node.) If your BBS software does NOT produce a file
  172. called DORINFOx.DEF when it shells to a door, you will need to use a convert
  173. program to create one for you. There are many different ones to do the job for
  174. you. Consult a guru familiar with running doors with your BBS software. A
  175. sample batch file to run Yankee Trader is listed below:
  176.  
  177. CD \YT
  178. YT C:\BBS\DORINFO1.DEF
  179. CD \BBS
  180.  
  181.         Yes, that's ALL there is to it! Just change to the door's directory
  182. and pass it the FULL PATH to and NAME of the DORINFOx.DEF file.
  183.  
  184.         Running Yankee Trader on a BBS with a high speed modem with the baud
  185. rate locked requires NO additional baud rate conversion programs OR command
  186. line options since the correct baud rate is AUTOMATICALLY detected! Yankee
  187. Trader supports COM1 through COM4 and baud rates from 75 to 115,200 baud. COM3
  188. and COM4 MUST NOT be on non-standard interrupts. (My thanks go to Raymond
  189. Clements for information on how to do auto-detect the baud rate and to Brad
  190. Garner for info on how to access COM3 and COM4.)
  191.  
  192.  
  193. Playing YT withOUT a BBS! :-
  194.  
  195.         SHARE MUST BE LOADED IN ORDER TO RUN YANKEE TRADER!
  196.  
  197.         I have included a program that you can use to log onto the game
  198. WITHOUT having a BBS! The program is called "LOCAL.EXE" and all you have to do
  199. to run it is to type "LOCAL" in your YT directory.
  200.  
  201.         "LOCAL" reads the user names from the Yankee Trader data files. You
  202. will be able to pick your name from a menu, rather than typing it in. You also
  203. may start "LOCAL" by typing "LOCAL #" where "#" is the number of user on the
  204. "LOCAL" menu or by typing "LOCAL [user name]. This will go right into YT
  205. without you having to wait for the menu to display.
  206.  
  207.  
  208. Running YT from your BBS :-
  209.  
  210.         Yankee Trader, even using the run time module, takes a lot of memory.
  211. At LEAST 300K for the 1.0 version. Later versions probably will take even
  212. MORE. For this reason you should NOT use a type 7 (Shell to program) exit from
  213. QuickBBS or Remote Access unless you use the "Memoryswap" option. What you
  214. MUST do if you do not use "Memoryswap" is a type 15 (Exit with errorlevel)
  215. exit. An example of a batch file to run YT from a QuickBBS type 15 exit is
  216. included with this package and is shown below;
  217.  
  218. Echo off
  219. :RESTART
  220. c:
  221. cd \quickbbs
  222. quickbbs -e1
  223.  
  224. :afterbbs
  225.  
  226. if errorlevel 50 goto YT
  227. if errorlevel 1 goto RESTART
  228.  
  229. Rem Allow exiting of batch file.
  230. goto endit
  231.  
  232. :RELOGIN
  233. c:
  234. cd \quickbbs
  235. quickbbs -r -e1
  236. goto afterbbs
  237.  
  238. :YT
  239. Rem Yankee Trader Batch File
  240. c:
  241. cd \quickbbs\doors\yt
  242. yt.exe c:\quickbbs\dorinfo1.def
  243. goto relogin
  244.  
  245. :Endit
  246. Echo QuickBBS is now down.
  247.  
  248.  
  249.         Using that batch file, you would set a type 15 exit on your YT menu
  250. using your QuickBBS menu editing program for the menu entry to load YT and
  251. place a "50" to exit with errorlevel 50 in the "Other Data" field.
  252.  
  253.  
  254. Dealing with problem players, "LOCKOUT.DAT" :-
  255.  
  256. You may lock anyone out of the game by placing their name in a file called
  257. "LOCKOUT.DAT". This file can be edited with any text editor. To use it, place
  258. the players REAL name as it appears on your BBS in "LOCKOUT.DAT" and they will
  259. be denied access to the game until you remove their name from "LOCKOUT.DAT".
  260.  
  261. Dealing with an unacceptable alias :-
  262.  
  263. Since your users can choose virtually any alias they wish in Yankee Trader,
  264. there is always the danger an immature individual will pick one that is
  265. unacceptable to you. You may change the alias of any user using the program
  266. called YTCONFIG.EXE. YTCONFIG is mainly for setting up default values in the
  267. game, however I added a function that will allow you to change player names
  268. due to popular request. You may also rename planets using YTCONFIG.
  269.  
  270.  
  271. Function Keys in YT :-
  272.  
  273. There are 5 function keys active on Yankee Trader. They are;
  274.  
  275. F4  - Toggles Local (Console) sounds on and off. Default is OFF when a remote
  276.       caller is online and ON when you are playing in the local mode. The
  277.       users can control their own remote sounds and they are totally
  278.       independent of the local sounds.
  279.   
  280. F5  - End now! This is the "nuke" key. Hitting F5 will close all files and
  281.       the communication port, and exit immediately.
  282.  
  283. F8  - Adjust users time in the door. You will be prompted for how much time to
  284.       give the player. (Either more or less time.) Enter the time in minutes.
  285.       0 minutes will log them off. (F5 is quicker.)
  286.  
  287. F9  - Toggle local screen ON/OFF for remote callers. Has no effect when logged
  288.       on locally.
  289.  
  290. F10 - Chat with online user. This will allow you to type in real time with a
  291.       user logged into the game. The user's time does not decrease in chat.
  292.       Hit [ESCAPE] to terminate chat with the user.
  293.  
  294.  
  295. Problems? :-
  296.  
  297. That's basically it on setup. Some common problems you might run into are:
  298.  
  299. Problem: "When someone uses the autopilot, the game crashes".
  300. Answer : Not enough memory. The door needs at least 300K to run.
  301.  
  302. Problem: "The door runs for a while then locks up tight."
  303. Answer : There is enough memory to let the game start, but not enough to hold
  304.          all the variables once the game has run for a while. Give it MORE
  305.          ROOM to run in!
  306.  
  307. Problem: "The door hangs up the phone on my users when they try to exit back
  308.          to my BBS."
  309. Answer : You are NOT using the specially patched version of BRUN30.EXE
  310.          provided! (OR you have another version someplace in your system path
  311.          someplace that is being found BEFORE the patched version.)
  312.  
  313. Problem: "The game crashes when generating the scoreboard."
  314. Answer : You have the path/name set up to and invalid path/name. Use YTCONFIG
  315.          and fix the path/name.
  316.  
  317. Problem: "The door reports 'Command line missing. Aborting!'"
  318. Answer : You MUST pass on the command line the path/name of/to DORINFO1.DEF.
  319.  
  320. Problem: "The door will not start and reports a problem accessing DORINFO1.DEF"
  321. Answer : You may have passed an invalid path to DORINFO1.DEF OR you just
  322.          passed the PATH. You must pass both the path AND the name. (See the
  323.          example.)
  324.  
  325. Problem: "The Door reports "ERROR 64" when a remote caller tries to play."
  326. Answer : If you are running Desqview, you have to define the COM port in the
  327.          DV window that YT is running in else it thinks there is NO com port
  328.          available. (See DV-NOTES.TXT.)
  329.  
  330.  
  331. Notes on lockups when running from a BBS using the MEMORYSWAP option. :-
  332.  
  333. Due to problems inherent with QuickBasic, you MAY experience machine lockups
  334. if you use the memory swap option of Remote Access BBS or others. This is due
  335. to memory being fragmented. I cannot do a thing about it unfortunately since
  336. it is inherent to QuickBasic HOWEVER there is a way to prevent lockups from
  337. happening. There are utilities that allow removal of TSRs. They are oldies but
  338. still are quite useful. It will allow you to put a bookmark in memory and then
  339. erase memory (remove) TSRs later. This utility also nicely corrects the memory
  340. fragmentation problem of QB doors. I've included MARK.COM and RELEASE.COM with
  341. this package. MARK places a bookmark in memory, RELEASE will free up memory
  342. from the last bookmark. To use it, you would add the following lines to your
  343. YT.BAT file. The utilities are in UPPER CASE in the example below;
  344.  
  345. cd \bbs\doors\yt
  346. MARK
  347. yt \bbs\dorinfo1.def
  348. RELEASE
  349. cd \bbs
  350.  
  351. This should solve any lockup problems caused by memory fragmentation you may
  352. experience. NOTE: This is not needed if you run RA/QBBS and use type 15 exits.
  353.  
  354. Suggestions and Reporting Bugs :-
  355.  
  356.         This is the most sticky thing about writing doors. Why? I find that
  357. 90% of all bugs reported are NOT really bugs and that when 90% of real bugs
  358. are reported I am not given enough information to track down and SOLVE the
  359. problem! This is extremely irritating and frustrating to me and makes me want
  360. to hang it all up and forget about it all!
  361.  
  362.         If a you do not like the way a routine works that is NOT a bug and
  363. rather than reporting it as one it is much less irritating if you make a
  364. SUGGESTION for a change and/or and improvement. Before making a suggestion
  365. think to yourself 'Is it practical?' I receive "suggestions" all the time
  366. (usually by non-programmers) that, if implemented, would totally change the
  367. game or would take so much to implement that it would take a lifetime to add!
  368. (I do this in my spare time as a hobby!) A LOT of thought has gone into the
  369. game and establishing a reasonable game balance. Think about your suggestion.
  370. Will it enhance the game or will it just mess up the game balance? I DO listen
  371. to suggestions when they are well though out and when they are accompanied by
  372. an explanation of just WHY the person thinks that it would enhance the game.
  373.  
  374.         When reporting real bugs (crashes, non-functioning or malfunctioning
  375. routines) please, before reporting it to me, gather as much information as
  376. possible. Write down the EXACT circumstances that cause the bug to appear. If
  377. I cannot reproduce the problem, I cannot fix it! Nothing is more frustrating
  378. to me, as a programmer, to know that there is a problem however am unable to
  379. do anything about it since it was reported with too little information to
  380. track it down!! Please be explicit and detailed when reporting any problems
  381. you may encounter otherwise you are wasting your time and irritating the
  382. person who spent so much time to bring YT to you. Thank you!
  383.  
  384.  
  385. Registration of Yankee Trader :-
  386.  
  387.         Please see "REGISTER.DOC" for a registration form for registering
  388. Yankee Trader. Registration is $20.00 U.S. When I recieve your registration
  389. form, you will be netmailed (if you are in the Fidonet Nodelist) or you will
  390. be mailed a letter with your registration code. To register Yankee Trader, use
  391. your favorite text editor to create a file called "YT.REG" containing THREE
  392. lines. Your BBS's name, your name, and your registration code number to
  393. activate your registration. You should type your name and BBS name EXACTLY as
  394. it appears in the letter. Make a mistake and the key will not work.  Place
  395. this file in your Yankee Trader directory. An example of a key file is below:
  396.  
  397. John Doe's BBS
  398. John Doe
  399. 1934829892
  400.  
  401. That is what you would type into "YT.REG" if you run "John Doe's BBS" and are
  402. "John Doe" and your registration code is "1934829892". Make sure that there is
  403. NO BLANK LINE at the top of the key file when you type it in!
  404.  
  405.  
  406. Getting New Versions :-
  407.  
  408.         You can always download the latest version of Yankee Trader from my
  409. BBS. OR you may file request it from 1:13/75 any time but Zone 1 Mail Hour. My
  410. BBS phone number is 1-717-686-3037 16800 HST / 14400 v.32b/v.42b.
  411.  
  412.  
  413. A Final Word :-
  414.  
  415.         I wish to thank everyone who has helped test the early, buggy beta
  416. test versions of Yankee Trader. I was going to try to list you all but I am
  417. afraid that I would miss someone and insult them by leaving their name out. So
  418. I'll just say this; "Thank you one and all. Your help was appreciated more
  419. than you can ever know!"
  420.